<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Lock</title>
			<link rel="stylesheet" href="../../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Interface Lock</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Represents a lock placed on an item.</p>
<p class="description"><p>Level 2 only</p><p>A lock is associated with an <a href="../../phpContentRepository/Item.html">Item</a> and a user (not a <a href="../../phpContentRepository/Ticket.html">Ticket</a>)</p></p>
	<ul class="tags">
				<li><span class="field">copyright:</span> Copyright &amp;copy; 2004-2005, Domain51</li>
				<li><span class="field">author:</span> PHP - Travis Swicegood &lt;<a href="mailto:travis@domain51.net">travis@domain51.net</a>&gt;</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_lock_Lock_interface_php.html">/lock/Lock.interface.php</a> (line <span class="field">39</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
								
				<div class="method-definition">
											<span class="method-result">object
 An</span>
										<a href="#getItem" title="details" class="method-name">getItem</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">mixed</span>
										<a href="#getOwner" title="details" class="method-name">getOwner</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">int</span>
										<a href="#getType" title="details" class="method-name">getType</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">bool</span>
										<a href="#isShared" title="details" class="method-name">isShared</a>
										()
									</div>
							</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodgetItem" id="getItem"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getItem</span> (line <span class="line-number">79</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the locked item.</p>
	<ul class="tags">
				<li><span class="field">return:</span> <a href="../../phpContentRepository/Item.html">Item</a> object.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">object
 An</span>
		<span class="method-name">
			getItem
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodgetOwner" id="getOwner"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getOwner</span> (line <span class="line-number">48</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the user ID of the user who has this lock.</p>
	<ul class="tags">
				<li><span class="field">return:</span> A user ID.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">mixed</span>
		<span class="method-name">
			getOwner
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodgetType" id="getType"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getType</span> (line <span class="line-number">60</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the type of this lock. This standard specifies only one type of  lock: <a href="../../phpContentRepository/Level2/LockType.html#constWRITE_LOCK">LockType::WRITE_LOCK</a> though more can be supported by a  specific phpCR implementation.</p>
	<ul class="tags">
				<li><span class="field">return:</span> The type of this lock.</li>
				<li><span class="field">access:</span> public</li>
				<li><span class="field">see:</span> <a href="../../phpContentRepository/Level2/LockCapabilities.html#methodgetSupportedLockTypes">LockCapabilities::getSupportedLockTypes()</a>, <a href="../../phpContentRepository/Level2/LockType.html">LockType</a></li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			getType
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodisShared" id="isShared"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">isShared</span> (line <span class="line-number">70</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns TRUE if this lock is a shared lock.</p>
	<ul class="tags">
				<li><span class="field">return:</span> TRUE if this is a shered lock, FALSE    otherwise.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			isShared
		</span>
				()
			</div>
	
		
		
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Fri, 31 Dec 2004 10:15:12 -0600 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a>
	</p>
	</div></body>
</html>